<?php
/**
 * This code is licensed under the BSD 3-Clause License.
 *
 * Copyright (c) 2017, Maks Rafalko
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

declare(strict_types=1);

namespace Infection\Tests\Mutation;

use Infection\AbstractTestFramework\Coverage\TestLocation;
use Infection\Mutation\Mutation;
use PhpParser\Node;
use PhpParser\Token;
use PHPUnit\Framework\Assert;

/**
 * A mutation has some lazy/computed state hence two mutations can be equal yet have different states. To
 * compare two mutations without this issue, the assertions of this class should be used instead.
 */
final class MutationAssertions
{
    public static function assertEquals(
        Mutation $expected,
        Mutation $actual,
    ): void {
        self::assertStateIs(
            mutation: $actual,
            expectedOriginalFilePath: $expected->getOriginalFilePath(),
            expectedOriginalFileAst: $expected->getOriginalFileAst(),
            expectedMutatorClass: $expected->getMutatorClass(),
            expectedMutatorName: $expected->getMutatorName(),
            expectedAttributes: $expected->getAttributes(),
            expectedMutatedNodeClass: $expected->getMutatedNodeClass(),
            expectedTests: $expected->getAllTests(),
            expectedFileTokens: $expected->getOriginalFileTokens(),
            expectedOriginalFileContent: $expected->getOriginalFileContent(),
            expectedCoveredByTests: $expected->isCoveredByTest(),
        );
    }

    /**
     * @param Node[] $expectedOriginalFileAst
     * @param (string|int|float)[] $expectedAttributes
     * @param TestLocation[] $expectedTests
     * @param Token[] $expectedFileTokens
     */
    public static function assertStateIs(
        Mutation $mutation,
        string $expectedOriginalFilePath,
        array $expectedOriginalFileAst,
        string $expectedMutatorClass,
        string $expectedMutatorName,
        array $expectedAttributes,
        string $expectedMutatedNodeClass,
        array $expectedTests,
        array $expectedFileTokens,
        string $expectedOriginalFileContent,
        bool $expectedCoveredByTests,
    ): void {
        Assert::assertSame($expectedOriginalFilePath, $mutation->getOriginalFilePath());
        Assert::assertEquals($expectedOriginalFileAst, $mutation->getOriginalFileAst());
        Assert::assertSame($expectedMutatorClass, $mutation->getMutatorClass());
        Assert::assertSame($expectedMutatorName, $mutation->getMutatorName());
        Assert::assertSame($expectedAttributes, $mutation->getAttributes());
        Assert::assertSame($expectedMutatedNodeClass, $mutation->getMutatedNodeClass());
        Assert::assertEquals($expectedTests, $mutation->getAllTests());
        Assert::assertEquals($expectedFileTokens, $mutation->getOriginalFileTokens());
        Assert::assertSame($expectedOriginalFileContent, $mutation->getOriginalFileContent());
        Assert::assertSame($expectedCoveredByTests, $mutation->isCoveredByTest());
    }
}
